6  Release Package & User Guides

6.1 Deliverable Package

6.1.1 Source Codes & Documents

No. Items Sub-Items Type Version
Code package
1 EduBlock EduBlock Client New 1.0
2 Blockchain Network Blockchain Chaincode New 1.0
3 OCR Record Table Processor New 1.0
Database
1 Tables accounts.sql New 1.0
classrooms.sql New 1.0
subjects.sql New 1.0
Documents
1 Requirement SRS_v1.0.docx New 1.0
2 Deployment UserGuide_v1.0.docx New 1.0

6.1.2 Known Issues, Limitations & Restrictions

6.2 Installation Guides

6.2.1 System Requirements

OS: any

CPU: at least 4 cores

RAM: at least 4Gb

NETWORK: required

SOFTWARE: Docker

6.2.2 Setup Files

  • Dockerfile.backend
  • Dockerfile.frontend
  • Dockerfile.ocr

6.2.3 Installation Instruction

6.3 User Manual

6.3.1 Terms & Definitions

No. Term Definition
01 FT Feature
02 R.GUEST Guest, Third-party
03 R.ADM Admin
04 R.STF Staff
05 R.TCH Teacher
06 R.STD Student
07 R.AUTH Any authenticated role
08 R.MAN Admin or Staff
09 R.USR Teacher or Student
10 R.PRV Personal

6.3.2 System Requirements

OS: any

CPU: any

RAM: at least 1Gb

NETWORK: required

6.3.3 Application Usage

6.3.3.1 Overview

No. Feature R.ADM R.STF R.TCH R.STD R.GUEST Note
01 Login x x x x
02 View list of all accounts x x
03 View details of an account x x
04 Create new accounts x
05 Search account x x
06 Update own profile x x x x
07 Change others account password x
08 Get classification report of year and grade x x
09 Get report of a classroom x x x
10 View list of all classrooms x x
11 View details of a classroom x x x x
12 Create new classroom x
13 Update details of a classroom x
14 View list of students of a classroom x x x
15 Assign multiple students to a classroom x
16 View details of a student x x x
17 Update details of a student x
18 Remove a student from classroom x
19 View list of teachers of a classroom x x x x
20 Assign multiple teachers to a classroom x
21 Remove a teacher from classroom x
22 Print record table of a student x x x x
23 View own profile x x x x
24 Update own password x x x x
25 View teaching classrooms x
26 Request update record of student x x
27 Request update record of student by image x x
28 Update a record of student x
29 View list of pending record’s update requests x
30 Approve or reject record update request x
31 View update history of a record of student x x x x
32 View list of classroom taking part in x
33 View own records x
34 Create key to view records of a student x
35 View list of keys to view records of a student x
36 Remove a key to view records of a student x
37 Create key to view records of students x x
38 View list of keys to view records of students x x
39 Remove a key to view records of students x x
40 View verified records of a student x x x x x
41 View verified records of students x x x x x

6.3.3.2 Login

Step Description Effect Figure
01 Click Login in the homepage Navigate to login page Figure 6.1
02 Fill the form with provided credential Figure 6.2
03 Click Login to submit the credential Navigate to dashboard if credential is valid Figure 6.3

Figure 6.1: Step 1

Figure 6.2: Step 2

Figure 6.3: Step 3

Figure 6.4: Result

6.3.3.3 View list of all accounts

Step Description Effect Figure
01 Click on Account in the left sidebar Navigate to the account list page Figure 6.5

Figure 6.5: Step 1

Figure 6.6: Result

6.3.3.4 View details of an account

Step Description Effect Figure
01 Click on Account in the left sidebar Navigate to the account list page Figure 6.7
02 Find the target account Figure 6.8
03 Click on Details in the Actions column of the table Navigate to the account’s profile page Figure 6.9

Figure 6.7: Step 1

Figure 6.8: Step 2

Figure 6.9: Step 3

Figure 6.10: Result

6.3.3.5 Create new accounts

Step Description Effect Figure
00 Follow Feature 02 to navigate to the account list page
01 Click on Create to open the accounts creation form A modal with form show up Figure 6.11
02 Fill the form with desired values Figure 6.12
03 Click on Create Accounts New accounts added at the end of list Figure 6.13

Figure 6.11: Step 1

Figure 6.12: Step 2

Figure 6.13: Step 3

Figure 6.14: Result

6.3.3.6 Search an account

Step Description Effect Figure
00 Follow Feature 02 to navigate to the account list page
01 Click on Search to show search input Search input visible Figure 6.15
02 Fill the input with desired values List of accounts auto refreshed with search value Figure 6.16

Figure 6.15: Step 1

Figure 6.16: Step 2

Figure 6.17: Result

6.3.3.7 Update own profile

Step Description Effect Figure
01 Click on Account name in the left sidebar Navigate to the profile page Figure 6.18
02 Click on Update profile to open profile update form A modal with form show up Figure 6.19
03 Fill the form with desired values Figure 6.20
04 Click on Submit Update if form values is valid Figure 6.21

Figure 6.18: Step 1

Figure 6.19: Step 2

Figure 6.20: Step 3

Figure 6.21: Step 4

Figure 6.22: Result

6.3.3.8 Change other’s password

Step Description Effect Figure
00 Follow Feature 02 to navigate to the account list page
01 Find the target account Figure 6.23
02 Click on Update password in the Actions column A modal with form show up Figure 6.24
03 Fill the form with desired values Figure 6.25
04 Click on Update Password for target account updated Figure 6.26

Figure 6.23: Step 1

Figure 6.24: Step 2

Figure 6.25: Step 3

Figure 6.26: Step 4

6.3.3.9 Get classification report of grade and year

Step Description Effect Figure
01 Click on Dashboard in the left sidebar Navigate to the dashboard page Figure 6.27
02 Select grade and year Figure 6.28
03 Click on Get grade report or Get classification report Report file can be download if exist Figure 6.29

Figure 6.27: Step 1

Figure 6.28: Step 2

Figure 6.29: Step 3

Figure 6.30: Result

6.3.3.10 Get report of a classroom

Step Description Effect Figure
01 Click on Classroom in the left sidebar Navigate to the classroom list page Figure 6.31
02 Find the target classroom Figure 6.32
03 Click on Details in the Actions column Navigate to the classroom details page Figure 6.33
04 Click on Get semester report or Get subject report Report file can be download Figure 6.34

Figure 6.31: Step 1

Figure 6.32: Step 2

Figure 6.33: Step 3

Figure 6.34: Step 4

Figure 6.35: Result

6.3.3.11 View list of all classrooms

Step Description Effect Figure
01 Click on Classroom in the left sidebar Navigate to the classroom list page Figure 6.36

Figure 6.36: Step 1

Figure 6.37: Result

6.3.3.12 View details of a classroom

6.3.3.12.1 R.MAN
Step Description Effect Figure
00 Follow Feature 10 to navigate to the classroom list page
01 Find the target classroom Figure 6.38
02 Click on Details in the Actions column Navigate to the classroom details page Figure 6.39

Figure 6.38: Step 1

Figure 6.39: Step 2

Figure 6.40: Result

6.3.3.12.2 R.USR
Step Description Effect Figure
01 Click on Dashboard in the left sidebar Navigate to the dashboard page Figure 6.41
02 Find the target classroom Figure 6.42
03 Click on Details in the Actions column Navigate to the classroom details page Figure 6.43

Figure 6.41: Step 1

Figure 6.42: Step 2

Figure 6.43: Step 3

Figure 6.44: Result

6.3.3.13 Create new classroom

Step Description Effect Figure
00 Follow Feature 10 to navigate to classroom list page
01 Click on Create A modal with form show up Figure 6.45
02 Fill the form with desired value Figure 6.46
03 Click on Create classroom New classroom created Figure 6.47

Figure 6.45: Step 1

Figure 6.46: Step 2

Figure 6.47: Step 3

6.3.3.14 Update details of a classroom

Step Description Effect Figure
00 Follow Feature 11 to navigate to target classroom details
01 Click on Update details A modal with form show up Figure 6.48
02 Fill the form with desired value Figure 6.49
03 Click on Update Classroom details updated Figure 6.50

Figure 6.48: Step 1

Figure 6.49: Step 2

Figure 6.50: Step 3

6.3.3.15 View list of students of a classroom

Step Description Effect Figure
00 Follow Feature 11 to navigate to target classroom details
01 Click on Students Figure 6.51

Figure 6.51: Step 1

Figure 6.52: Result

6.3.3.16 Assign multiple students to classroom

Step Description Effect Figure
00 Follow Feature 14 to navigate to student list of target classroom
01 Click on Add students A modal with form show up Figure 6.53
02 Fill the form with desired value Figure 6.54
03 Click on Confirm New student appear in target classroom Figure 6.55

Figure 6.53: Step 1

Figure 6.54: Step 2

Figure 6.55: Step 3

6.3.3.17 View details of a student

6.3.3.17.1 R.MAN
Step Description Effect Figure
00 Follow Feature 02 to navigate to list of accounts
01 Find the target student Figure 6.56
02 Click on Details on the Actions column Navigate to the target student profile Figure 6.57

Figure 6.56: Step 1

Figure 6.57: Step 2

Figure 6.58: Result

6.3.3.17.2 R.TCH
Step Description Effect Figure
00 Follow Feature 14 to navigate to student list of a classroom
01 Find the target student Figure 6.59
02 Click on Details on the Actions column Navigate to the target student profile Figure 6.60

Figure 6.59: Step 1

Figure 6.60: Step 2

Figure 6.61: Result

6.3.3.18 Update details of a student

Step Description Effect Figure
00 Follow Feature 16 to navigate to student profile
01 Click on Update A modal with form show up Figure 6.62
02 Fill the form with desired values Figure 6.63
03 Click on Confirm Student information updated if provided form valid Figure 6.64

Figure 6.62: Step 1

Figure 6.63: Step 2

Figure 6.64: Step 3

6.3.3.19 Remove a student from classroom

Step Description Effect Figure
00 Follow Feature 14 to navigate to student list of a classroom
01 Find the target student Figure 6.65
02 Click on Remove on the Actions column Target student removed from classroom Figure 6.66

Figure 6.65: Step 1

Figure 6.66: Step 2

6.3.3.20 View list of teachers of a classroom

Step Description Effect Figure
00 Follow Feature 11 to navigate to classroom details
01 Click on Teachers Figure 6.67

Figure 6.67: Step 1

Figure 6.68: Result

6.3.3.21 Assign multiple teachers to a classroom

Step Description Effect Figure
00 Follow Feature 19 to navigate to teacher list of a classroom
01 Click on Add teachers A modal with form show up Figure 6.69
02 Fill the form with desired values Figure 6.70
03 Click on Confirm New teachers added to target classroom Figure 6.71

Figure 6.69: Step 1

Figure 6.70: Step 2

Figure 6.71: Step 3

6.3.3.22 Remove a teacher from classroom

Step Description Effect Figure
00 Follow Feature 19 to navigate to teacher list of a classroom
01 Find the target teacher Figure 6.72
02 Click on Remove Target teacher removed from classroom Figure 6.73

Figure 6.72: Step 1

Figure 6.73: Step 2

6.3.3.24 View own profile

Step Description Effect Figure
01 Click on Account name in the left sidebar Navigate to the profile page Figure 6.77

Figure 6.77: Step 1

Figure 6.78: Result

6.3.3.25 Update own password

Step Description Effect Figure
00 Follow Feature 23 to navigate to profile page
01 Click on Change password A modal with form appear Figure 6.79
02 Fill the form with desired values Figure 6.80
03 Click on Submit Password updated Figure 6.81

Figure 6.79: Step 1

Figure 6.80: Step 2

Figure 6.81: Step 3

Figure 6.82: Result

6.3.3.26 View teaching classroom

Step Description Effect Figure
01 Click on Dashboard Show list of teaching classroom Figure 6.83

Figure 6.83: Step 1

Figure 6.84: Result

6.3.3.27 Request record update

6.3.3.27.1 R.TCH
Step Description Effect Figure
00 Follow Feature 25 to navigate to teaching classroom list
01 Click Details in the Actions column Navigate to classroom details Figure 6.85
02 Click Students Navigate to classroom student list Figure 6.86
03 Find the target student Figure 6.87
04 Click on Details in the Actions column Navigate to student record of current classroom Figure 6.88
05 Find the target record Figure 6.89
06 Click on Request in the Actions column A modal with form show up Figure 6.90
07 Fill the form with desired values Figure 6.91
08 Click on Request Request sent Figure 6.92

Figure 6.85: Step 1

Figure 6.86: Step 2

Figure 6.87: Step 3

Figure 6.88: Step 4

Figure 6.89: Step 5

Figure 6.90: Step 6

Figure 6.91: Step 7

Figure 6.92: Step 8

Figure 6.93: Result

6.3.3.27.2 R.STD
Step Description Effect Figure
00 Follow Feature 23 to navigate to profile page
01 Find the target classroom Record data switch to target classroom Figure 6.94
02 Find the target record Figure 6.95
03 Click on Request in the Actions column A modal with form show up Figure 6.96
04 Fill the form with desired values Figure 6.97
05 Click on Request Request sent Figure 6.98

Figure 6.94: Step 1

Figure 6.95: Step 2

Figure 6.96: Step 3

Figure 6.97: Step 4

Figure 6.98: Step 5

Figure 6.99: Result

6.3.3.28 Request record update by legacy record image

6.3.3.28.1 R.TCH
Step Description Effect Figure
00 Follow Feature 25 to navigate to teaching classroom list
01 Click Details in the Actions column Navigate to classroom details Figure 6.100
02 Click Students Navigate to classroom student list Figure 6.101
03 Find the target student Figure 6.102
04 Click on Details in the Actions column Navigate to student record of current classroom Figure 6.103
05 Click on Upload next to Record Heading A modal with form show up Figure 6.104
06 Fill the form with desired values Figure 6.105
07 Click on Submit Request sent Figure 6.106

Figure 6.100: Step 1

Figure 6.101: Step 2

Figure 6.102: Step 3

Figure 6.103: Step 4

Figure 6.104: Step 5

Figure 6.105: Step 6

Figure 6.106: Step 7

Figure 6.107: Result

6.3.3.28.2 R.STD
Step Description Effect Figure
00 Follow Feature 23 to navigate to profile page
01 Find the target classroom Record data switch to target classroom Figure 6.108
02 Click on Upload next to Record Heading A modal with form show up Figure 6.109
03 Fill the form with desired values Figure 6.110
04 Click on Submit Request sent Figure 6.111

Figure 6.108: Step 1

Figure 6.109: Step 2

Figure 6.110: Step 3

Figure 6.111: Step 4

Figure 6.112: Result

6.3.3.29 Update a record of student

Step Description Effect Figure
00 Follow Feature 25 to navigate to teaching classroom list
01 Click Details in the Actions column Navigate to classroom details Figure 6.113
02 Click Students Navigate to classroom student list Figure 6.114
03 Find the target student Figure 6.115
04 Click on Details in the Actions column Navigate to student record of current classroom Figure 6.116
05 Find the target record Figure 6.117
06 Click on Request in the Actions column A modal with form show up Figure 6.118
07 Fill the form with desired values Figure 6.119
08 Click on Request Record updated Figure 6.120

Figure 6.113: Step 1

Figure 6.114: Step 2

Figure 6.115: Step 3

Figure 6.116: Step 4

Figure 6.117: Step 5

Figure 6.118: Step 6

Figure 6.119: Step 7

Figure 6.120: Step 8

Figure 6.121: Result

6.3.3.30 View list of pending record update requests

Step Description Effect Figure
01 Click on Pending request in the Actions column Navigate to request list Figure 6.122

Figure 6.122: Step 1

Figure 6.123: Result

6.3.3.31 Approve or reject record update request

Step Description Effect Figure
00 Follow Feature 29 to navigate to request list page
01 Find the target request Figure 6.124
02 Click Approve or Reject the request Request status changed Figure 6.125

Figure 6.124: Step 1

Figure 6.125: Step 2

Figure 6.126: Result

6.3.3.32 View update history of a record of student

Step Description Effect Figure
00 Follow Feature 16 to navigate to student profile
01 Find the target classroom Record data switch to target classroom Figure 6.127
02 Find the target record Figure 6.128
03 Hover History in the Actions column A temporary card show update history Figure 6.129

Figure 6.127: Step 1

Figure 6.128: Step 2

Figure 6.129: Step 3

Figure 6.130: Result

6.3.3.33 View list of classroom taking part in

Step Description Effect Figure
01 Click on Dashboard Navigate to classroom list Figure 6.131

Figure 6.131: Step 1

Figure 6.132: Result

6.3.3.34 View own records

Step Description Effect Figure
00 Follow Feature 23 to navigate to own record page Figure 6.133

Figure 6.133: Step 1

Figure 6.134: Result

6.3.3.35 Create key to view records of a student

Step Description Effect Figure
01 Click on Manage verified keys Navigate to verified key list page Figure 6.135
02 Click on Create new key new key created Figure 6.136

Figure 6.135: Step 1

Figure 6.136: Step 2

Figure 6.137: Result

6.3.3.36 View list of keys to view records of a student

Step Description Effect Figure
01 Click on Manage verified keys Navigate to verified key list page Figure 6.138

Figure 6.138: Step 1

Figure 6.139: Result

6.3.3.37 Remove a key to view records of a student

Step Description Effect Figure
00 Follow Feature 35 to navigate to the list of verified key page
01 Find the target key Figure 6.140
01 Click on Remove Target key removed Figure 6.141

Figure 6.140: Step 1

Figure 6.141: Step 2

Figure 6.142: Result

6.3.3.38 Create key to view records of students

Step Description Effect Figure
01 Click on Manage stats key list Navigate to verified key list page Figure 6.143
02 Select year and grade for the key Figure 6.144
02 Click on Create new key new key created Figure 6.145

Figure 6.143: Step 1

Figure 6.144: Step 2

Figure 6.145: Step 3

Figure 6.146: Result

6.3.3.39 View list of keys to view records of students

Step Description Effect Figure
01 Click on Manage stats key list Navigate to verified key list page Figure 6.147

Figure 6.147: Step 1

Figure 6.148: Result

6.3.3.40 Remove a key to view records of students

Step Description Effect Figure
00 Follow Feature 38 to navigate to the list of verified key page
01 Find the target key Figure 6.149
01 Click on Remove Target key removed Figure 6.150

Figure 6.149: Step 1

Figure 6.150: Step 2

Figure 6.151: Result

6.3.3.41 View verified records of a student

Step Description Effect Figure
01 Press Ctrl + K A command pallette show up Figure 6.152
02 Select View verified data Navigate to verified data page Figure 6.153
02 Input key Show verified data of the provided key Figure 6.154

Figure 6.152: Step 1

Figure 6.153: Step 2

Figure 6.154: Step 3

Figure 6.155: Result

6.3.3.42 View verified records of students

Step Description Effect Figure
01 Press Ctrl + K A command pallette show up Figure 6.156
02 Select View verified data list Navigate to verified data page Figure 6.157
02 Input key Show verified data of the provided key Figure 6.158

Figure 6.156: Step 1

Figure 6.157: Step 2

Figure 6.158: Step 3

Figure 6.159: Result

6.3.4 Troubleshooting